home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / c / sas-c-emacs-b3.lha / slashquote / slashquote.doc < prev    next >
Encoding:
Text File  |  1994-03-20  |  1.2 KB  |  53 lines
  1.  
  2.               Slashquote.library
  3.  
  4.  
  5.                    Written
  6.                   by
  7.  
  8.           Anders Lindgren, d91ali@csd.uu.se
  9.  
  10.  
  11.  
  12. Slashquote.library is a one-function ARexx-library used by the SAS/C -
  13. Emacs connection program. Add it to your system with the command:
  14.  
  15.     rxlib slashquote.library -20 -30 0
  16.  
  17.  
  18.  
  19. slashquote.library/SLASHQUOTE
  20.  
  21.    NAME
  22.     SLASHQUOTE - Prefix special characters in a string.
  23.  
  24.    SYNOPSIS
  25.     str = SLASHQUOTE(str)
  26.         or
  27.     str = SLASHQUOTE(str, char)
  28.  
  29.    FUNCTION
  30.     Handles strings with should be sent through a parser by putting
  31.     a special character before any occurances of that character and
  32.     the double quote character. It then returns the string quoted.
  33.  
  34.     If no argument for the special character is given, backslash
  35.     is used.
  36.  
  37.     The function was originally written for the program Mg3a, as
  38.     a replace for a slow arexx macro by the same name. Mg3a uses
  39.     the backslash and double-quote as special characters.
  40.     It can also be used in command shells to fix arguments. Other
  41.     uses can surely be found, like passing strings to GNUEmacs.
  42.     
  43.    EXAMPLE
  44.  
  45.     arg1        arg2        returned
  46.     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  47.     hello        <none>        "hello"
  48.     hel\lo        <none>        "hel\\lo"
  49.     h"el\lo        <none>        "h\"el\\lo"
  50.     h"el\lo        *        "h*"el\lo"
  51.     h"el*lo        *        "h*"el**lo"
  52.     "hi"        <none>        "\"hi\""
  53.